yTextbox

Description

The yTextbox component serves as a powerful tool primarily designed for displaying longer text information within your application. It's an element that allows only static content. The yTextbox basically can be used to store text information that goes beyond the context of a simple label.

Basic Structure

In the following the basic structure of the yTextbox shall be explained. For the general structure of a yComponent please visit the

YBase-components basic-structure.

The yTextbox as seen above contains nothing but text as the content.

Content

The content contains the actual text itself. It can be seen as an equivalent to the label of the

yLabel. You can find further explanation at the [Content Property](#style--content).

Properties

Through its various properties the yTextbox can be configured to suit your needs. The display below provides you with an overview of all the yTextbox properties.

Properties can be changed directly through three methods:

• Inside the Toolbar, which is positioned in your workarea next to your component where you need it. It shows the most important properties, thus providing a fast and efficient way to configure your component in the most basic way.
• It may also occur in the Toolbar Extension, which is a seamless extension accesible as a dropdown item of the Toolbar. It extends the functionality of the Toolbar by providing advanced pickers for most used properties.
• Inside the Detail Panel, which is located in the righthand drawer. Every property of a component can be configured here.

Generic

METAread more

Name: componentId

Not Editable

Number Property

--y-textbox__component-id

The identifier of the component that is unique within a page.

Name: componentType

Not Editable

String Property

--y-textbox__component-type

The type of the component. For this component it is -textbox.

Name: name

String Property

--y-textbox__name

The custom name of the component. It serves for better identification of the component.

Name: version

String Property

--y-textbox__version

The custom version of the Textbox-component. This can be used to ensure that all components work well together.

Name: coreTheme

String Property

--y-textbox__core-theme

The CoreTheme, which will be apllied to the Textbox. For further information on themes visit the themes page.

Name: subTheme

String Property

--y-textbox__sub-theme

The subtheme subordinated to the previously specified CoreTheme, which will be apllied to the Textbox. For further information on themes visit the themes page.

Name: groupTheme

String Property

--y-textbox__group-theme

The group theme is a further variation of the subtheme which is specified especially for variations of a component inside the subtheme. For further information on themes visit the Theme-Manager page.

DISPLAYread more

Name: display

String Property

--y-textbox__display

This property specifies the display behavior of the component. This can be be set to:

• none
• block
• flex
• inline

Name: position

Not Editable

String Property

--y-textbox__position

This property specifies the type of positioning method used for the component. This can be be set to:

• static
• relative
• absolute
• sticky
• fixed

Name: visible

String Property

--y-textbox__visible

This property can toggle the visibility of the component. The two modes are completely hidden and fully shown.

SIZEread more

Name: minWidth

Injectable

UnitNumber Property

--y-textbox__min-width

The minimum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: minHeight

Injectable

UnitNumber Property

--y-textbox__min-height

The minimum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: width

Injectable

UnitNumber Property

--y-textbox__width

The value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: height

Injectable

UnitNumber Property

--y-textbox__height

The value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: maxWidth

Injectable

UnitNumber Property

--y-textbox__max-width

The maximum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: maxHeight

Injectable

UnitNumber Property

--y-textbox__max-height

The maximum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: flex

String Property

--y-textbox__flex

The flex property sets the length on flexible items. This sets the value in n-fold shares extrapolated to all other components with the flex display within the same container.

PLACEMENTread more

Name: marginTop

Injectable

UnitNumber Property

--y-textbox__margin-top

This property creates a space around the component, outside of the top border. This can be set in percent or pixels.

Name: marginRight

Injectable

UnitNumber Property

--y-textbox__margin-right

This property creates a space around the component, outside of the right border. This can be set in percent or pixels.

Name: marginBottom

Injectable

UnitNumber Property

--y-textbox__margin-bottom

This property creates a space around the component, outside of the bottom border. This can be set in percent or pixels.

Name: marginLeft

Injectable

UnitNumber Property

--y-textbox__margin-left

This property creates a space around the component, outside of the left border. This can be set in percent or pixels.

Name: paddingTop

Injectable

UnitNumber Property

--y-textbox__padding-top

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Name: paddingRight

Injectable

UnitNumber Property

--y-textbox__padding-right

This property creates a space within the component, inside of the right border. This can be set in percent or pixels.

Name: paddingBottom

Injectable

UnitNumber Property

--y-textbox__padding-bottom

This property creates a space within the component, inside of the bottom border. This can be set in percent or pixels.

Name: paddingLeft

Injectable

UnitNumber Property

--y-textbox__padding-left

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Style

BACKGROUNDread more

Name: bgColor

Injectable

Color Property

--y-textbox__bg-color

--y-textbox__bg-color__normal

--y-textbox__bg-color__hover

The color of the background. This can be set as a color from a palette or a custom hex color.

BORDERread more

Name: borderTopColor

Injectable

Color Property

--y-textbox__border-top-color

--y-textbox__border-top-color__normal

--y-textbox__border-top-color__hover

The color of the top border. This can be set as a color from a palette or a custom hex color.

Name: borderTopStyle

Injectable

String Property

--y-textbox__border-top-style

--y-textbox__border-top-style__normal

--y-textbox__border-top-style__hover

The style of the top border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderTopWidth

Injectable

UnitNumber Property

--y-textbox__border-top-width

--y-textbox__border-top-width__normal

--y-textbox__border-top-width__hover

The width of the top border. This can be set in percent or pixels.

Name: borderRightColor

Injectable

Color Property

--y-textbox__border-right-color

--y-textbox__border-right-color__normal

--y-textbox__border-right-color__hover

The color of the right border. This can be set as a color from a palette or a custom hex color.

Name: borderRightStyle

Injectable

String Property

--y-textbox__border-right-style

--y-textbox__border-right-style__normal

--y-textbox__border-right-style__hover

The style of the right border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderRightWidth

Injectable

UnitNumber Property

--y-textbox__border-right-width

--y-textbox__border-right-width__normal

--y-textbox__border-right-width__hover

The width of the right border. This can be set in percent or pixels.

Name: borderBottomColor

Injectable

Color Property

--y-textbox__border-bottom-color

--y-textbox__border-bottom-color__normal

--y-textbox__border-bottom-color__hover

The color of the bottom border. This can be set as a color from a palette or a custom hex color.

Name: borderBottomStyle

Injectable

String Property

--y-textbox__border-bottom-style

--y-textbox__border-bottom-style__normal

--y-textbox__border-bottom-style__hover

The style of the bottom border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderBottomWidth

Injectable

UnitNumber Property

--y-textbox__border-bottom-width

--y-textbox__border-bottom-width__normal

--y-textbox__border-bottom-width__hover

The width of the bottom border. This can be set in percent or pixels.

Name: borderLeftColor

Injectable

Color Property

--y-textbox__border-left-color

--y-textbox__border-left-color__normal

--y-textbox__border-left-color__hover

The color of the left border. This can be set as a color from a palette or a custom hex color.

Name: borderLeftStyle

Injectable

String Property

--y-textbox__border-left-style

--y-textbox__border-left-style__normal

--y-textbox__border-left-style__hover

The style of the left border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderLeftWidth

Injectable

UnitNumber Property

--y-textbox__border-left-width

--y-textbox__border-left-width__normal

--y-textbox__border-left-width__hover

The width of the left border. This can be set in percent or pixels.

Name: borderRadius

Injectable

UnitNumber Property

--y-textbox__border-radius

The radius of the corners of all the borders. This can be set in percent or pixels.

SHADOWread more

Name: boxShadow

Injectable

String Property

--y-textbox__box-shadow

--y-textbox__box-shadow__normal

--y-textbox__box-shadow__hover

The shadow of the component. This is set by the 4 sub-properties x, y, blur and spread of the shadow-property, which can be further read about in the shadow-property section.

OPACITYread more

Name: opacity

Injectable

Number Property

--y-textbox__opacity

--y-textbox__opacity__normal

--y-textbox__opacity__hover

The opacity of all colored parts of the component. This value is set in percent.

CONTENTread more

Name: contentHrefNormal__color

Injectable

Color Property

--y-textbox__content-href-normal__color

The color of normal links inside the Textbox-component.

Name: contentHrefHover__color

Injectable

Color Property

--y-textbox__content-href-hover__color

The color of hovered links inside the Textbox-component.

Name: contentHrefActive__color

Injectable

Color Property

--y-textbox__content-href-active__color

The color of active links inside the Textbox-component.

Name: contentHrefVisited__color

Injectable

Color Property

--y-textbox__content-href-visited__color

The color of visited links inside the Textbox-component.

Name: contentH1__fontSize

Injectable

UnitNumber Property

--y-textbox__content-h1__font-size

The font-size of h1-headings inside the Textbox-component.

Name: contentH2__fontSize

Injectable

UnitNumber Property

--y-textbox__content-h2__font-size

The font-size of h2-headings inside the Textbox-component.

Name: contentH3__fontSize

Injectable

UnitNumber Property

--y-textbox__content-h3__font-size

The font-size of h3-headings inside the Textbox-component.

Name: contentH1__color

Injectable

Color Property

--y-textbox__content-h1__color

The color of h1-headings inside the Textbox-component.

Name: contentH2__color

Injectable

Color Property

--y-textbox__content-h2__color

The color of h2-headings inside the Textbox-component.

Name: contentH3__color

Injectable

Color Property

--y-textbox__content-h3__color

The color of h3-headings inside the Textbox-component.

Name: contentH1__fontFamily

Injectable

String Property

--y-textbox__content-h1__font-family

The font-family of h1-headings inside the Textbox-component.

Name: contentH2__fontFamily

Injectable

String Property

--y-textbox__content-h2__font-family

The font-family of h2-headings inside the Textbox-component.

Name: contentH3__fontFamily

Injectable

String Property

--y-textbox__content-h3__font-family

The font-family of h3-headings inside the Textbox-component.

Name: content__fontColor

Injectable

Color Property

--y-textbox__content__font-color

--y-textbox__content__font-color__normal

--y-textbox__content__font-color__hover

The font-color of the text-content inside the Textbox-component.

Name: content__fontFamily

Injectable

String Property

--y-textbox__content__font-family

--y-textbox__content__font-family__normal

--y-textbox__content__font-family__hover

The font-family of the text-content inside the Textbox-component.

Name: content__fontWeight

Injectable

Number Property

--y-textbox__content__font-weight

--y-textbox__content__font-weight__normal

--y-textbox__content__font-weight__hover

The font-weight of the text-content inside the Textbox-component.

Name: content__fontStyle

Injectable

String Property

--y-textbox__content__font-style

--y-textbox__content__font-style__normal

--y-textbox__content__font-style__hover

The font-style of the text-content inside the Textbox-component.

Name: content__fontSize

Injectable

UnitNumber Property

--y-textbox__content__font-size

The font-size of the text-content inside the Textbox-component.

Name: content__overflowY

String Property

--y-textbox__content__overflow-y

This property specifies the behavior, when content inside the Textbox-component is higher than its parent(horizontally). This can be set to:

• visible
• hidden
• scroll
• auto

Name: value

String Property

--y-textbox__value

The content to be displayed inside the Textbox-component.

Events

LIFECYCLEread more

Name: EvtInit

String Property

--y-textbox__-evt-init

This specifies the function to be called, when the Textbox is initialized.

Usage

In this section you'll find a collection of application scenarios and examples that illustrate how to leverage the yTextbox in ways that deviate from its standard behavior, as defined by yBase. This section aims to inspire and guide you through various possibilities, helping you to implement more complex or unique functionalities tailored to your specific needs. General properties that are universally applicable can be found in the yBase usage section.

Variations

Elevated

genericarrow_forward_iossizearrow_forward_iosminWidth200px

genericarrow_forward_iossizearrow_forward_iosmaxWidth200px

genericarrow_forward_iossizearrow_forward_iosheight100px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosshadowarrow_forward_iosboxShadow__normal0 3px 6px 0 rgba(16, 18, 24, 0.2)

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

stylearrow_forward_ioscontentarrow_forward_iosvalue'<p>This is an example text:</p><p></p><ol><li><p>Elevated</p></li></ol>'

Flat

genericarrow_forward_iossizearrow_forward_iosminWidth200px

genericarrow_forward_iossizearrow_forward_iosmaxWidth200px

genericarrow_forward_iossizearrow_forward_iosheight100px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

stylearrow_forward_ioscontentarrow_forward_iosvalue'<p>This is an example text:</p><p></p><ol><li><p>Flat</p></li></ol>'

Outlined

genericarrow_forward_iossizearrow_forward_iosminWidth200px

genericarrow_forward_iossizearrow_forward_iosmaxWidth200px

genericarrow_forward_iossizearrow_forward_iosheight100px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normaltransparent

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderStyleTop__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleRight__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleBottom__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleLeft__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderWidthTop__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthRight__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthBottom__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthLeft__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderColorTop__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorRight__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorBottom__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorLeft__normal#44ddbb

stylearrow_forward_ioscontentarrow_forward_iosvalue'<p>This is an example text:</p><p></p><ol><li><p>Outlined</p></li></ol>'

Rounded

genericarrow_forward_iossizearrow_forward_iosminWidth200px

genericarrow_forward_iossizearrow_forward_iosmaxWidth200px

genericarrow_forward_iossizearrow_forward_iosheight100px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosshadowarrow_forward_iosboxShadow__normal0 3px 6px 0 rgba(16, 18, 24, 0.2)

stylearrow_forward_iosborderarrow_forward_iosborderRadius20px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

stylearrow_forward_ioscontentarrow_forward_iosvalue'<p>This is an example text:</p><p></p><ol><li><p>Rounded</p></li></ol>'

Plain

genericarrow_forward_iossizearrow_forward_iosminWidth200px

genericarrow_forward_iossizearrow_forward_iosmaxWidth200px

genericarrow_forward_iossizearrow_forward_iosheight100px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normaltransparent

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#44ddbb

stylearrow_forward_ioscontentarrow_forward_iosvalue'<p>This is an example text:</p><p></p><ol><li><p>Plain</p></li></ol>'

Special Variations

Using tags

genericarrow_forward_iossizearrow_forward_iosminWidth200px

genericarrow_forward_iossizearrow_forward_iosmaxWidth200px

genericarrow_forward_iossizearrow_forward_iosheight100px

stylearrow_forward_ioscontentarrow_forward_iosvalue<p><strong>Hello world!</strong> <i><a href='www.vectorsoft.de'>Click here :-)<a></i> </p>

Styling links

genericarrow_forward_iossizearrow_forward_iosminWidth200px

genericarrow_forward_iossizearrow_forward_iosmaxWidth200px

genericarrow_forward_iossizearrow_forward_iosheight100px

stylearrow_forward_ioscontentarrow_forward_iosvalue<p><i><a href='www.vectorsoft.de'>Click here :-)<a></i> </p>

stylearrow_forward_ioscontentarrow_forward_ioscontent-href-normal__color#0000FF

stylearrow_forward_ioscontentarrow_forward_ioscontent-href-hover__color#0000FF

stylearrow_forward_ioscontentarrow_forward_ioscontent-href-active__color#0000FF

stylearrow_forward_ioscontentarrow_forward_ioscontent-href-visited__color#FF00FF

Different headings

genericarrow_forward_iossizearrow_forward_iosminWidth400px

genericarrow_forward_iossizearrow_forward_iosmaxWidth400px

genericarrow_forward_iossizearrow_forward_iosheight250px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_ioscontentarrow_forward_iosvalue<p><h1>This is a Heading</h1><ul><li> First </li><li> Second </li><li> Third </li></ul><h2> This is a subheading </h2></p>

stylearrow_forward_ioscontentarrow_forward_iosfont-size10px

stylearrow_forward_ioscontentarrow_forward_iosfont-color#FFFFFF

stylearrow_forward_ioscontentarrow_forward_ioscontent-h3__font-size12px

stylearrow_forward_ioscontentarrow_forward_ioscontent-h2__font-size18px

stylearrow_forward_ioscontentarrow_forward_ioscontent-h1__font-size30px

stylearrow_forward_ioscontentarrow_forward_ioscontent-h3__font-color#FFFFFF

stylearrow_forward_ioscontentarrow_forward_ioscontent-h2__font-color#FFFFFF

stylearrow_forward_ioscontentarrow_forward_ioscontent-h1__font-color#FFFFFF

Special Picker

Rich text editor

This special editor helps creating a content of your liking. The principle can be compared to a common text editor.

@Note hier Bild einfügen

The editor can be activated by double clicking the textbox in the @Note insert Link Designer. Now the textbox turns from simply displaying the content to an editor mode. In this mode you can simply create, edit and delete content.

The Toolbar hereby offers several options:

1. Undo/Redo
2. Changing fonts
3. Changing font styles
4. Creating link
5. Inserting ordered and unordered lists
6. Updating font align
7. Creating different headings
8. Colorizing the background of certain text parts
9. A rubber for resetting and clearing the style of text parts
10. A reset to clear the complete content